<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Copyright 2007 the original author or authors.<a name="line.2"></a>
<FONT color="green">003</FONT>     *<a name="line.3"></a>
<FONT color="green">004</FONT>     * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<FONT color="green">005</FONT>     * you may not use this file except in compliance with the License.<a name="line.5"></a>
<FONT color="green">006</FONT>     * You may obtain a copy of the License at<a name="line.6"></a>
<FONT color="green">007</FONT>     *<a name="line.7"></a>
<FONT color="green">008</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<FONT color="green">009</FONT>     *<a name="line.9"></a>
<FONT color="green">010</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<FONT color="green">011</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<FONT color="green">012</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<FONT color="green">013</FONT>     * See the License for the specific language governing permissions and<a name="line.13"></a>
<FONT color="green">014</FONT>     * limitations under the License.<a name="line.14"></a>
<FONT color="green">015</FONT>     */<a name="line.15"></a>
<FONT color="green">016</FONT>    package org.codehaus.groovy.grails.plugins.searchable.compass.search;<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    import org.codehaus.groovy.grails.plugins.searchable.compass.support.AbstractSearchableMethod;<a name="line.18"></a>
<FONT color="green">019</FONT>    import org.codehaus.groovy.grails.plugins.searchable.compass.support.SearchableMethodUtils;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.codehaus.groovy.grails.plugins.searchable.compass.mapping.CompassMappingUtils;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.codehaus.groovy.grails.plugins.searchable.SearchableMethod;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.codehaus.groovy.grails.plugins.searchable.lucene.LuceneUtils;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.codehaus.groovy.grails.commons.GrailsApplication;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.compass.core.*;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.compass.core.engine.SearchEngineQueryParseException;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.springframework.util.Assert;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.lucene.queryParser.ParseException;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.lucene.analysis.WhitespaceAnalyzer;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.lucene.index.Term;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.commons.logging.Log;<a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.commons.logging.LogFactory;<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>    import java.util.*;<a name="line.33"></a>
<FONT color="green">034</FONT>    import java.util.regex.Pattern;<a name="line.34"></a>
<FONT color="green">035</FONT>    import java.util.regex.Matcher;<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>    import groovy.lang.Closure;<a name="line.37"></a>
<FONT color="green">038</FONT>    <a name="line.38"></a>
<FONT color="green">039</FONT>    /**<a name="line.39"></a>
<FONT color="green">040</FONT>     * @author Maurice Nicholson<a name="line.40"></a>
<FONT color="green">041</FONT>     */<a name="line.41"></a>
<FONT color="green">042</FONT>    public class DefaultSuggestQueryMethod extends AbstractSearchableMethod implements SearchableMethod {<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>        private SearchableCompassQueryBuilder compassQueryBuilder;<a name="line.44"></a>
<FONT color="green">045</FONT>        private GrailsApplication grailsApplication;<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>        public DefaultSuggestQueryMethod(String methodName, Compass compass, GrailsApplication grailsApplication) {<a name="line.47"></a>
<FONT color="green">048</FONT>            this(methodName, compass, grailsApplication, new HashMap());<a name="line.48"></a>
<FONT color="green">049</FONT>        }<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>        public DefaultSuggestQueryMethod(String methodName, Compass compass, GrailsApplication grailsApplication, Map defaultOptions) {<a name="line.51"></a>
<FONT color="green">052</FONT>            super(methodName, compass, null, defaultOptions);<a name="line.52"></a>
<FONT color="green">053</FONT>            this.grailsApplication = grailsApplication;<a name="line.53"></a>
<FONT color="green">054</FONT>        }<a name="line.54"></a>
<FONT color="green">055</FONT>    <a name="line.55"></a>
<FONT color="green">056</FONT>        public Object invoke(Object[] args) {<a name="line.56"></a>
<FONT color="green">057</FONT>            if (!CompassMappingUtils.hasSpellCheckMapping(getCompass())) {<a name="line.57"></a>
<FONT color="green">058</FONT>                throw new IllegalStateException(<a name="line.58"></a>
<FONT color="green">059</FONT>                    "Suggestions are only available when classes are mapped with \"spellCheck\" options, either at the class " +<a name="line.59"></a>
<FONT color="green">060</FONT>                    "or property level. The simplest way to do this is add spellCheck \"include\" to the domain class searchable mapping closure. " +<a name="line.60"></a>
<FONT color="green">061</FONT>                    "See the plugin/Compass documentation Mapping sections for details."<a name="line.61"></a>
<FONT color="green">062</FONT>                );<a name="line.62"></a>
<FONT color="green">063</FONT>            }<a name="line.63"></a>
<FONT color="green">064</FONT>            if (!"true".equals(getCompass().getSettings().getSetting("compass.engine.spellcheck.enable"))) {<a name="line.64"></a>
<FONT color="green">065</FONT>                throw new IllegalStateException(<a name="line.65"></a>
<FONT color="green">066</FONT>                    "Suggestions are only available when the Compass Spell Check feature is enabled, but currently it is not. " +<a name="line.66"></a>
<FONT color="green">067</FONT>                    "Please set Compass setting 'compass.engine.spellcheck.enable' to 'true'. " +<a name="line.67"></a>
<FONT color="green">068</FONT>                    "One way to so this is to use the SearchableConfiguration.groovy file (run \"grails install-searchable-config\") and " +<a name="line.68"></a>
<FONT color="green">069</FONT>                    "add \"'compass.engine.spellcheck.enable': 'true'\" to the compassSettings Map. " +<a name="line.69"></a>
<FONT color="green">070</FONT>                    "Also see the Spell Check section in the Compass docs for additional settings."<a name="line.70"></a>
<FONT color="green">071</FONT>                );<a name="line.71"></a>
<FONT color="green">072</FONT>            }<a name="line.72"></a>
<FONT color="green">073</FONT>    <a name="line.73"></a>
<FONT color="green">074</FONT>            Object query = SearchableMethodUtils.getQueryArgument(args);<a name="line.74"></a>
<FONT color="green">075</FONT>            if (query instanceof Closure) {<a name="line.75"></a>
<FONT color="green">076</FONT>                throw new UnsupportedOperationException("Closure queries are not support for query suggestions, only String queries.");<a name="line.76"></a>
<FONT color="green">077</FONT>            }<a name="line.77"></a>
<FONT color="green">078</FONT>            Assert.isInstanceOf(String.class, query, "Only String queries are supported for query suggestions");<a name="line.78"></a>
<FONT color="green">079</FONT>    <a name="line.79"></a>
<FONT color="green">080</FONT>            SuggestQueryCompassCallback suggestQueryCallback = new SuggestQueryCompassCallback(getCompass(), getDefaultOptions(), args);<a name="line.80"></a>
<FONT color="green">081</FONT>            Map options = getOptions(args);<a name="line.81"></a>
<FONT color="green">082</FONT>            suggestQueryCallback.applyOptions(options);<a name="line.82"></a>
<FONT color="green">083</FONT>            suggestQueryCallback.setGrailsApplication(grailsApplication);<a name="line.83"></a>
<FONT color="green">084</FONT>            suggestQueryCallback.setCompassQueryBuilder(compassQueryBuilder);<a name="line.84"></a>
<FONT color="green">085</FONT>            return doInCompass(suggestQueryCallback);<a name="line.85"></a>
<FONT color="green">086</FONT>        }<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>
<FONT color="green">088</FONT>        public SearchableCompassQueryBuilder getCompassQueryBuilder() {<a name="line.88"></a>
<FONT color="green">089</FONT>            return compassQueryBuilder;<a name="line.89"></a>
<FONT color="green">090</FONT>        }<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>        public void setCompassQueryBuilder(SearchableCompassQueryBuilder compassQueryBuilder) {<a name="line.92"></a>
<FONT color="green">093</FONT>            this.compassQueryBuilder = compassQueryBuilder;<a name="line.93"></a>
<FONT color="green">094</FONT>        }<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>        public Map getOptions(Object[] args) {<a name="line.96"></a>
<FONT color="green">097</FONT>            Map options = new HashMap(getDefaultOptions()); // clone to avoid corrupting original<a name="line.97"></a>
<FONT color="green">098</FONT>            options.putAll(SearchableMethodUtils.getOptionsArgument(args, null));<a name="line.98"></a>
<FONT color="green">099</FONT>            return options;<a name="line.99"></a>
<FONT color="green">100</FONT>        }<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>        public static class SuggestQueryCompassCallback implements CompassCallback {<a name="line.102"></a>
<FONT color="green">103</FONT>            private Map defaultOptions;<a name="line.103"></a>
<FONT color="green">104</FONT>            private Object[] args;<a name="line.104"></a>
<FONT color="green">105</FONT>            private SearchableCompassQueryBuilder compassQueryBuilder;<a name="line.105"></a>
<FONT color="green">106</FONT>            private GrailsApplication grailsApplication;<a name="line.106"></a>
<FONT color="green">107</FONT>            private boolean userFriendly;<a name="line.107"></a>
<FONT color="green">108</FONT>            private boolean emulateCapitalisation;<a name="line.108"></a>
<FONT color="green">109</FONT>            private boolean escape;<a name="line.109"></a>
<FONT color="green">110</FONT>            private boolean allowSame;<a name="line.110"></a>
<FONT color="green">111</FONT>    <a name="line.111"></a>
<FONT color="green">112</FONT>            public SuggestQueryCompassCallback(Compass compass, Map defaultOptions, Object[] args) {<a name="line.112"></a>
<FONT color="green">113</FONT>                this.defaultOptions = defaultOptions;<a name="line.113"></a>
<FONT color="green">114</FONT>                this.args = args;<a name="line.114"></a>
<FONT color="green">115</FONT>            }<a name="line.115"></a>
<FONT color="green">116</FONT>    <a name="line.116"></a>
<FONT color="green">117</FONT>            public Object doInCompass(CompassSession session) throws CompassException {<a name="line.117"></a>
<FONT color="green">118</FONT>                Map options = SearchableMethodUtils.getOptionsArgument(args, defaultOptions);<a name="line.118"></a>
<FONT color="green">119</FONT>                options.put("analyzer", "searchableplugin_simple");<a name="line.119"></a>
<FONT color="green">120</FONT>                CompassQuery original = compassQueryBuilder.buildQuery(grailsApplication, session, options, args);<a name="line.120"></a>
<FONT color="green">121</FONT>                String queryString = original.getSuggestedQuery().toString();<a name="line.121"></a>
<FONT color="green">122</FONT>                String suggestedString = queryString;<a name="line.122"></a>
<FONT color="green">123</FONT>                if (options.containsKey("class")) {<a name="line.123"></a>
<FONT color="green">124</FONT>                    // Strip the additional junk from around the query - +(what test) +(alias:B)<a name="line.124"></a>
<FONT color="green">125</FONT>                    Pattern pattern = Pattern.compile("\\+\\((.+)\\) \\+\\(alias:.+\\)");<a name="line.125"></a>
<FONT color="green">126</FONT>                    Matcher matcher = pattern.matcher(queryString);<a name="line.126"></a>
<FONT color="green">127</FONT>                    if (!matcher.matches()) {<a name="line.127"></a>
<FONT color="green">128</FONT>                        return queryString;<a name="line.128"></a>
<FONT color="green">129</FONT>                    }<a name="line.129"></a>
<FONT color="green">130</FONT>                    suggestedString = matcher.group(1);<a name="line.130"></a>
<FONT color="green">131</FONT>                }<a name="line.131"></a>
<FONT color="green">132</FONT>                String originalString = (String) SearchableMethodUtils.getQueryArgument(args);<a name="line.132"></a>
<FONT color="green">133</FONT>                try {<a name="line.133"></a>
<FONT color="green">134</FONT>                    return new SuggestedQueryStringBuilder(originalString, suggestedString).<a name="line.134"></a>
<FONT color="green">135</FONT>                        userFriendly(userFriendly).<a name="line.135"></a>
<FONT color="green">136</FONT>                        emulateCapitalisation(emulateCapitalisation).<a name="line.136"></a>
<FONT color="green">137</FONT>                        escape(escape).<a name="line.137"></a>
<FONT color="green">138</FONT>                        allowSame(allowSame).<a name="line.138"></a>
<FONT color="green">139</FONT>                        toSuggestedQueryString();<a name="line.139"></a>
<FONT color="green">140</FONT>                } catch (ParseException ex) {<a name="line.140"></a>
<FONT color="green">141</FONT>                    throw new SearchEngineQueryParseException(<a name="line.141"></a>
<FONT color="green">142</FONT>                        "Failed to parse one of the queries: orignal [" + originalString + "], suggested: [" + suggestedString + "]",<a name="line.142"></a>
<FONT color="green">143</FONT>                        ex<a name="line.143"></a>
<FONT color="green">144</FONT>                    );<a name="line.144"></a>
<FONT color="green">145</FONT>                }<a name="line.145"></a>
<FONT color="green">146</FONT>            }<a name="line.146"></a>
<FONT color="green">147</FONT>    <a name="line.147"></a>
<FONT color="green">148</FONT>            public void setCompassQueryBuilder(SearchableCompassQueryBuilder compassQueryBuilder) {<a name="line.148"></a>
<FONT color="green">149</FONT>                this.compassQueryBuilder = compassQueryBuilder;<a name="line.149"></a>
<FONT color="green">150</FONT>            }<a name="line.150"></a>
<FONT color="green">151</FONT>    <a name="line.151"></a>
<FONT color="green">152</FONT>            public void setGrailsApplication(GrailsApplication grailsApplication) {<a name="line.152"></a>
<FONT color="green">153</FONT>                this.grailsApplication = grailsApplication;<a name="line.153"></a>
<FONT color="green">154</FONT>            }<a name="line.154"></a>
<FONT color="green">155</FONT>    <a name="line.155"></a>
<FONT color="green">156</FONT>            public void applyOptions(Map options) {<a name="line.156"></a>
<FONT color="green">157</FONT>                if (options == null) {<a name="line.157"></a>
<FONT color="green">158</FONT>                    return;<a name="line.158"></a>
<FONT color="green">159</FONT>                }<a name="line.159"></a>
<FONT color="green">160</FONT>                this.userFriendly = SearchableMethodUtils.getBool(options, "userFriendly", true);<a name="line.160"></a>
<FONT color="green">161</FONT>                this.emulateCapitalisation = SearchableMethodUtils.getBool(options, "emulateCapitalisation", true);<a name="line.161"></a>
<FONT color="green">162</FONT>                this.escape = SearchableMethodUtils.getBool(options, "escape", false);<a name="line.162"></a>
<FONT color="green">163</FONT>                this.allowSame = SearchableMethodUtils.getBool(options, "allowSame", true);<a name="line.163"></a>
<FONT color="green">164</FONT>            }<a name="line.164"></a>
<FONT color="green">165</FONT>        }<a name="line.165"></a>
<FONT color="green">166</FONT>    <a name="line.166"></a>
<FONT color="green">167</FONT>        public static class SuggestedQueryStringBuilder {<a name="line.167"></a>
<FONT color="green">168</FONT>            private static final Log LOG = LogFactory.getLog(SuggestedQueryStringBuilder.class);<a name="line.168"></a>
<FONT color="green">169</FONT>            private static final String defaultField = "$SuggestedQueryStringUtils_defaultField$";<a name="line.169"></a>
<FONT color="green">170</FONT>    <a name="line.170"></a>
<FONT color="green">171</FONT>            private String original;<a name="line.171"></a>
<FONT color="green">172</FONT>            private String suggested;<a name="line.172"></a>
<FONT color="green">173</FONT>            private boolean userFriendly = true;<a name="line.173"></a>
<FONT color="green">174</FONT>            private boolean emulateCapitalisation = true;<a name="line.174"></a>
<FONT color="green">175</FONT>            private boolean escape = false;<a name="line.175"></a>
<FONT color="green">176</FONT>            private boolean allowSame = true;<a name="line.176"></a>
<FONT color="green">177</FONT>    <a name="line.177"></a>
<FONT color="green">178</FONT>            /**<a name="line.178"></a>
<FONT color="green">179</FONT>             * Create a suggested query string builder with the given original and suggested query strings<a name="line.179"></a>
<FONT color="green">180</FONT>             * @param original the original query - probably from a user<a name="line.180"></a>
<FONT color="green">181</FONT>             * @param suggested the suggested query - probably from the Compass suggestion engine<a name="line.181"></a>
<FONT color="green">182</FONT>             */<a name="line.182"></a>
<FONT color="green">183</FONT>            public SuggestedQueryStringBuilder(String original, String suggested) {<a name="line.183"></a>
<FONT color="green">184</FONT>                this.original = original;<a name="line.184"></a>
<FONT color="green">185</FONT>                this.suggested = suggested;<a name="line.185"></a>
<FONT color="green">186</FONT>            }<a name="line.186"></a>
<FONT color="green">187</FONT>    <a name="line.187"></a>
<FONT color="green">188</FONT>            /**<a name="line.188"></a>
<FONT color="green">189</FONT>             * Enable/disable whether queries suggested by {@link #toSuggestedQueryString} are user-frienly,<a name="line.189"></a>
<FONT color="green">190</FONT>             * ie, look like the user's original query.<a name="line.190"></a>
<FONT color="green">191</FONT>             * This feature is enabled by default<a name="line.191"></a>
<FONT color="green">192</FONT>             * If you disable this feature, the emulateCapitalisation setting is ignored and the suggested query<a name="line.192"></a>
<FONT color="green">193</FONT>             * is returned by {@link # toSuggestedQueryString}  as-is<a name="line.193"></a>
<FONT color="green">194</FONT>             * @param userFriendly true or false to enable or disable<a name="line.194"></a>
<FONT color="green">195</FONT>             * @return this<a name="line.195"></a>
<FONT color="green">196</FONT>             */<a name="line.196"></a>
<FONT color="green">197</FONT>            public SuggestedQueryStringBuilder userFriendly(boolean userFriendly) {<a name="line.197"></a>
<FONT color="green">198</FONT>                this.userFriendly = userFriendly;<a name="line.198"></a>
<FONT color="green">199</FONT>                return this;<a name="line.199"></a>
<FONT color="green">200</FONT>            }<a name="line.200"></a>
<FONT color="green">201</FONT>    <a name="line.201"></a>
<FONT color="green">202</FONT>            /**<a name="line.202"></a>
<FONT color="green">203</FONT>             * Enable/disable the emulation of capitalised words.<a name="line.203"></a>
<FONT color="green">204</FONT>             * This feature is enabled by default<a name="line.204"></a>
<FONT color="green">205</FONT>             * @param emulateCapitalisation true or false to enable or disable<a name="line.205"></a>
<FONT color="green">206</FONT>             * @return this<a name="line.206"></a>
<FONT color="green">207</FONT>             */<a name="line.207"></a>
<FONT color="green">208</FONT>            public SuggestedQueryStringBuilder emulateCapitalisation(boolean emulateCapitalisation) {<a name="line.208"></a>
<FONT color="green">209</FONT>                this.emulateCapitalisation = emulateCapitalisation;<a name="line.209"></a>
<FONT color="green">210</FONT>                return this;<a name="line.210"></a>
<FONT color="green">211</FONT>            }<a name="line.211"></a>
<FONT color="green">212</FONT>    <a name="line.212"></a>
<FONT color="green">213</FONT>            /**<a name="line.213"></a>
<FONT color="green">214</FONT>             * Enable/disable whether to allow the same query to be suggested as the original<a name="line.214"></a>
<FONT color="green">215</FONT>             * This is enabled by default<a name="line.215"></a>
<FONT color="green">216</FONT>             * @param allowSame true or false to enable or disable<a name="line.216"></a>
<FONT color="green">217</FONT>             * @return this<a name="line.217"></a>
<FONT color="green">218</FONT>             */<a name="line.218"></a>
<FONT color="green">219</FONT>            public SuggestedQueryStringBuilder allowSame(boolean allowSame) {<a name="line.219"></a>
<FONT color="green">220</FONT>                this.allowSame = allowSame;<a name="line.220"></a>
<FONT color="green">221</FONT>                return this;<a name="line.221"></a>
<FONT color="green">222</FONT>            }<a name="line.222"></a>
<FONT color="green">223</FONT>    <a name="line.223"></a>
<FONT color="green">224</FONT>            /**<a name="line.224"></a>
<FONT color="green">225</FONT>             * Get the suggested query based on the options set<a name="line.225"></a>
<FONT color="green">226</FONT>             * @return the suggested query string or null if allowSame is false and the queries match<a name="line.226"></a>
<FONT color="green">227</FONT>             * @throws ParseException if either original or suggested query is invalid<a name="line.227"></a>
<FONT color="green">228</FONT>             */<a name="line.228"></a>
<FONT color="green">229</FONT>            public String toSuggestedQueryString() throws ParseException {<a name="line.229"></a>
<FONT color="green">230</FONT>                if (!userFriendly) {<a name="line.230"></a>
<FONT color="green">231</FONT>                    return suggested;<a name="line.231"></a>
<FONT color="green">232</FONT>                }<a name="line.232"></a>
<FONT color="green">233</FONT>    <a name="line.233"></a>
<FONT color="green">234</FONT>                Term[] originalTerms = LuceneUtils.realTermsForQueryString(defaultField, escape ? LuceneUtils.cleanQuery(original) : original, WhitespaceAnalyzer.class);<a name="line.234"></a>
<FONT color="green">235</FONT>                Term[] suggestedTerms = LuceneUtils.realTermsForQueryString(defaultField, suggested, WhitespaceAnalyzer.class);<a name="line.235"></a>
<FONT color="green">236</FONT>    <a name="line.236"></a>
<FONT color="green">237</FONT>                if (originalTerms.length != suggestedTerms.length) {<a name="line.237"></a>
<FONT color="green">238</FONT>                    LOG.warn(<a name="line.238"></a>
<FONT color="green">239</FONT>                        "Expected the same number of terms for original query [" + original + "] and suggested query [" + suggested + "], " +<a name="line.239"></a>
<FONT color="green">240</FONT>                        "but original query has [" + originalTerms.length + "] terms and suggested query has [" + suggestedTerms.length + "] terms " +<a name="line.240"></a>
<FONT color="green">241</FONT>                        "so unable to provide user friendly version. Returning suggested query as-is."<a name="line.241"></a>
<FONT color="green">242</FONT>                    );<a name="line.242"></a>
<FONT color="green">243</FONT>                    return suggested;<a name="line.243"></a>
<FONT color="green">244</FONT>                }<a name="line.244"></a>
<FONT color="green">245</FONT>    <a name="line.245"></a>
<FONT color="green">246</FONT>                StringBuffer userFriendly = new StringBuffer(original);<a name="line.246"></a>
<FONT color="green">247</FONT>                int offset = 0;<a name="line.247"></a>
<FONT color="green">248</FONT>                for (int i = 0; i &lt; originalTerms.length; i++) {<a name="line.248"></a>
<FONT color="green">249</FONT>                    Term originalTerm = originalTerms[i];<a name="line.249"></a>
<FONT color="green">250</FONT>                    boolean noField = originalTerm.field().equals(defaultField);<a name="line.250"></a>
<FONT color="green">251</FONT>                    String snippet = noField ? originalTerm.text() : originalTerm.field() + ":" + originalTerm.text();<a name="line.251"></a>
<FONT color="green">252</FONT>                    int pos = userFriendly.indexOf(snippet, offset);<a name="line.252"></a>
<FONT color="green">253</FONT>                    Term suggestedTerm = suggestedTerms[i];<a name="line.253"></a>
<FONT color="green">254</FONT>                    String replacement = getReplacement(originalTerm, noField, suggestedTerm);<a name="line.254"></a>
<FONT color="green">255</FONT>                    userFriendly.replace(pos, pos + snippet.length(), replacement);<a name="line.255"></a>
<FONT color="green">256</FONT>                    offset = pos;<a name="line.256"></a>
<FONT color="green">257</FONT>                }<a name="line.257"></a>
<FONT color="green">258</FONT>                String suggestion = userFriendly.toString();<a name="line.258"></a>
<FONT color="green">259</FONT>                if (!this.allowSame &amp;&amp; suggestion.equals(original)) {<a name="line.259"></a>
<FONT color="green">260</FONT>                    return null;<a name="line.260"></a>
<FONT color="green">261</FONT>                }<a name="line.261"></a>
<FONT color="green">262</FONT>                return suggestion;<a name="line.262"></a>
<FONT color="green">263</FONT>            }<a name="line.263"></a>
<FONT color="green">264</FONT>    <a name="line.264"></a>
<FONT color="green">265</FONT>            public SuggestedQueryStringBuilder escape(boolean escape) {<a name="line.265"></a>
<FONT color="green">266</FONT>                this.escape = escape;<a name="line.266"></a>
<FONT color="green">267</FONT>                return this;<a name="line.267"></a>
<FONT color="green">268</FONT>            }<a name="line.268"></a>
<FONT color="green">269</FONT>    <a name="line.269"></a>
<FONT color="green">270</FONT>            private String getReplacement(Term originalTerm, boolean noField, Term suggestedTerm) {<a name="line.270"></a>
<FONT color="green">271</FONT>                String replacement = noField ? suggestedTerm.text() : originalTerm.field() + ":" + suggestedTerm.text();<a name="line.271"></a>
<FONT color="green">272</FONT>                if (this.emulateCapitalisation) {<a name="line.272"></a>
<FONT color="green">273</FONT>                    boolean upperCase = true;<a name="line.273"></a>
<FONT color="green">274</FONT>                    boolean firstUpperCase = false;<a name="line.274"></a>
<FONT color="green">275</FONT>                    final String original = originalTerm.text();<a name="line.275"></a>
<FONT color="green">276</FONT>                    for (int i = 0; i &lt; original.length(); i++) {<a name="line.276"></a>
<FONT color="green">277</FONT>                        if (!Character.isUpperCase(original.charAt(i))) {<a name="line.277"></a>
<FONT color="green">278</FONT>                            upperCase = false;<a name="line.278"></a>
<FONT color="green">279</FONT>                            break;<a name="line.279"></a>
<FONT color="green">280</FONT>                        }<a name="line.280"></a>
<FONT color="green">281</FONT>                        if (i == 0) {<a name="line.281"></a>
<FONT color="green">282</FONT>                            firstUpperCase = true;<a name="line.282"></a>
<FONT color="green">283</FONT>                        }<a name="line.283"></a>
<FONT color="green">284</FONT>                    }<a name="line.284"></a>
<FONT color="green">285</FONT>                    if (upperCase) {<a name="line.285"></a>
<FONT color="green">286</FONT>                        return replacement.toUpperCase();<a name="line.286"></a>
<FONT color="green">287</FONT>                    }<a name="line.287"></a>
<FONT color="green">288</FONT>                    if (firstUpperCase) {<a name="line.288"></a>
<FONT color="green">289</FONT>                        return replacement.substring(0, 1).toUpperCase() + (replacement.length() &gt; 1 ? replacement.substring(1) : "");<a name="line.289"></a>
<FONT color="green">290</FONT>                    }<a name="line.290"></a>
<FONT color="green">291</FONT>                }<a name="line.291"></a>
<FONT color="green">292</FONT>                return replacement;<a name="line.292"></a>
<FONT color="green">293</FONT>            }<a name="line.293"></a>
<FONT color="green">294</FONT>        }<a name="line.294"></a>
<FONT color="green">295</FONT>    }<a name="line.295"></a>




























































</PRE>
</BODY>
</HTML>
